Skip to main content

FlowTrigger Properties

An object defining properties for the FlowTrigger class.

Caption

The caption dictionary representing localized captions for the flow object.

Type: Dictionary<string, string>


ProjectName

The name of the project to which this flow trigger belongs.

Type: string


FlowName

The name of the flow associated with this trigger.

Type: string


Source

The source options for the flow trigger.

Type: IFlowTriggerSourceOptions


Key

A unique identifier for the workflow step.

Type: string


ParentProcessId

The ID of the parent process for this flow trigger.

Type: long?


Name

Name for the workflow step.

Type: string


TriggeredProcessCountVariable

The variable to store the count of triggered processes.

Type: string


StarterUserType

The type of the starter user (e.g., UserId or UserName).

Type: UserIdentifierType


WorkflowCodeInstance

The workflow code instance associated with the flow object.

Type: IWorkflowCode


ShowFlowHistory

Determines whether to show the flow's history.

Type: bool


Parameters

A dictionary of flow parameters associated with this flow trigger.

Type: Dictionary<string, IFlowParameter>


CachedDMObjects

The cached document management objects related to the flow object.

Type: IRuntimeDMObjects


TypeCode

The type code associated with the flow object.

Type: WorkflowItemTypeCode
Accepted Values:

NameValue
FlowComment-1
FlowStart10
FlowEnd11
FlowPosition15
FlowAssign21
FlowCompare22
FlowOr24
FlowAnd25
FlowMail26
FlowProfession27
FlowDepartment28
Variable30
FlowScript31
FlowNode33
FlowGroup37
FlowTimer39
FlowTimerStarter40
FlowTimerStopper41
FlowApprovalCancellar42
Pauser44
SubFlowCall51
SubFlowBegin52
SubFlowEnd53
FlowPushNotification54
FlowDocument56
FlowCreateDocument57
FlowDocumentSynchronizer58
FlowStarterPosition59
FlowDocumentState63
FlowUniqueIdCreator65
FlowSetDocumentId66
FlowDeleteDocument67
FlowPDFExport68
FlowXMLExport69
FlowMailSender75
FlowParallel79
FlowContinue80
FlowTrigger81
FlowActionCreator82
FlowDigitallySigning83
FlowGptPrompt84

ProjectId

The ID of the project to which this flow trigger belongs.

Type: string


FlowId

The ID of the flow associated with this trigger.

Type: string


StarterUser

The user who starts the flow.

Type: string